home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / shseqr.z / shseqr
Encoding:
Text File  |  2002-10-03  |  7.1 KB  |  199 lines
  1.  
  2.  
  3.  
  4. SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))                                                          SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SHSEQR - compute the eigenvalues of a real upper Hessenberg matrix H and,
  10.      optionally, the matrices T and Z from the Schur decomposition H = Z T
  11.      Z**T, where T is an upper quasi-triangular matrix (the Schur form), and Z
  12.      is the orthogonal matrix of Schur vectors
  13.  
  14. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  15.      SUBROUTINE SHSEQR( JOB, COMPZ, N, ILO, IHI, H, LDH, WR, WI, Z, LDZ, WORK,
  16.                         LWORK, INFO )
  17.  
  18.          CHARACTER      COMPZ, JOB
  19.  
  20.          INTEGER        IHI, ILO, INFO, LDH, LDZ, LWORK, N
  21.  
  22.          REAL           H( LDH, * ), WI( * ), WORK( * ), WR( * ), Z( LDZ, * )
  23.  
  24. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  25.      These routines are part of the SCSL Scientific Library and can be loaded
  26.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  27.      directs the linker to use the multi-processor version of the library.
  28.  
  29.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  30.      4 bytes (32 bits). Another version of SCSL is available in which integers
  31.      are 8 bytes (64 bits).  This version allows the user access to larger
  32.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  33.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  34.      only one of the two versions; 4-byte integer and 8-byte integer library
  35.      calls cannot be mixed.
  36.  
  37. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  38.      SHSEQR computes the eigenvalues of a real upper Hessenberg matrix H and,
  39.      optionally, the matrices T and Z from the Schur decomposition H = Z T
  40.      Z**T, where T is an upper quasi-triangular matrix (the Schur form), and Z
  41.      is the orthogonal matrix of Schur vectors. Optionally Z may be
  42.      postmultiplied into an input orthogonal matrix Q, so that this routine
  43.      can give the Schur factorization of a matrix A which has been reduced to
  44.      the Hessenberg form H by the orthogonal matrix Q:  A = Q*H*Q**T =
  45.      (QZ)*T*(QZ)**T.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      JOB     (input) CHARACTER*1
  50.              = 'E':  compute eigenvalues only;
  51.              = 'S':  compute eigenvalues and the Schur form T.
  52.  
  53.      COMPZ   (input) CHARACTER*1
  54.              = 'N':  no Schur vectors are computed;
  55.              = 'I':  Z is initialized to the unit matrix and the matrix Z of
  56.              Schur vectors of H is returned; = 'V':  Z must contain an
  57.              orthogonal matrix Q on entry, and the product Q*Z is returned.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))                                                          SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix H.  N >= 0.
  76.  
  77.      ILO     (input) INTEGER
  78.              IHI     (input) INTEGER It is assumed that H is already upper
  79.              triangular in rows and columns 1:ILO-1 and IHI+1:N. ILO and IHI
  80.              are normally set by a previous call to SGEBAL, and then passed to
  81.              SGEHRD when the matrix output by SGEBAL is reduced to Hessenberg
  82.              form. Otherwise ILO and IHI should be set to 1 and N
  83.              respectively.  1 <= ILO <= IHI <= N, if N > 0; ILO=1 and IHI=0,
  84.              if N=0.
  85.  
  86.      H       (input/output) REAL array, dimension (LDH,N)
  87.              On entry, the upper Hessenberg matrix H.  On exit, if JOB = 'S',
  88.              H contains the upper quasi-triangular matrix T from the Schur
  89.              decomposition (the Schur form); 2-by-2 diagonal blocks
  90.              (corresponding to complex conjugate pairs of eigenvalues) are
  91.              returned in standard form, with H(i,i) = H(i+1,i+1) and
  92.              H(i+1,i)*H(i,i+1) < 0. If JOB = 'E', the contents of H are
  93.              unspecified on exit.
  94.  
  95.      LDH     (input) INTEGER
  96.              The leading dimension of the array H. LDH >= max(1,N).
  97.  
  98.      WR      (output) REAL array, dimension (N)
  99.              WI      (output) REAL array, dimension (N) The real and imaginary
  100.              parts, respectively, of the computed eigenvalues. If two
  101.              eigenvalues are computed as a complex conjugate pair, they are
  102.              stored in consecutive elements of WR and WI, say the i-th and
  103.              (i+1)th, with WI(i) > 0 and WI(i+1) < 0. If JOB = 'S', the
  104.              eigenvalues are stored in the same order as on the diagonal of
  105.              the Schur form returned in H, with WR(i) = H(i,i) and, if
  106.              H(i:i+1,i:i+1) is a 2-by-2 diagonal block, WI(i) =
  107.              sqrt(H(i+1,i)*H(i,i+1)) and WI(i+1) = -WI(i).
  108.  
  109.      Z       (input/output) REAL array, dimension (LDZ,N)
  110.              If COMPZ = 'N': Z is not referenced.
  111.              If COMPZ = 'I': on entry, Z need not be set, and on exit, Z
  112.              contains the orthogonal matrix Z of the Schur vectors of H.  If
  113.              COMPZ = 'V': on entry Z must contain an N-by-N matrix Q, which is
  114.              assumed to be equal to the unit matrix except for the submatrix
  115.              Z(ILO:IHI,ILO:IHI); on exit Z contains Q*Z.  Normally Q is the
  116.              orthogonal matrix generated by SORGHR after the call to SGEHRD
  117.              which formed the Hessenberg matrix H.
  118.  
  119.      LDZ     (input) INTEGER
  120.              The leading dimension of the array Z.  LDZ >= max(1,N) if COMPZ =
  121.              'I' or 'V'; LDZ >= 1 otherwise.
  122.  
  123.      WORK    (workspace/output) REAL array, dimension (LWORK)
  124.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))                                                          SSSSHHHHSSSSEEEEQQQQRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      LWORK   (input) INTEGER
  141.              The dimension of the array WORK.  LWORK >= max(1,N).
  142.  
  143.              If LWORK = -1, then a workspace query is assumed; the routine
  144.              only calculates the optimal size of the WORK array, returns this
  145.              value as the first entry of the WORK array, and no error message
  146.              related to LWORK is issued by XERBLA.
  147.  
  148.      INFO    (output) INTEGER
  149.              = 0:  successful exit
  150.              < 0:  if INFO = -i, the i-th argument had an illegal value
  151.              > 0:  if INFO = i, SHSEQR failed to compute all of the
  152.              eigenvalues in a total of 30*(IHI-ILO+1) iterations; elements
  153.              1:ilo-1 and i+1:n of WR and WI contain those eigenvalues which
  154.              have been successfully computed.
  155.  
  156. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  157.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  158.  
  159.      This man page is available only online.
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.